Security News
38% of CISOs Fear They’re Not Moving Fast Enough on AI
CISOs are racing to adopt AI for cybersecurity, but hurdles in budgets and governance may leave some falling behind in the fight against cyber threats.
@inquirer/editor
Advanced tools
@inquirer/editor
Prompt that'll open the user preferred editor with default content and allow for a convenient multi-line input controlled through the command line.
The editor launched is the one defined by the user's EDITOR
environment variable.
Inquirer's terminal of choice!
Available for MacOS and Linux
npm | yarn |
---|---|
|
|
Or | |
|
|
import { editor } from '@inquirer/prompts';
// Or
// import editor from '@inquirer/editor';
const answer = await editor({
message: 'Enter a description',
});
Property | Type | Required | Description |
---|---|---|---|
message | string | yes | The question to ask |
default | string | no | Default value which will automatically be present in the editor |
validate | string => boolean | string | Promise<boolean | string> | no | On submit, validate the content. When returning a string, it'll be used as the error message displayed to the user. Note: returning a rejected promise, we'll assume a code error happened and crash. |
postfix | string | no (default to .txt ) | The postfix of the file being edited. Adding this will add color highlighting to the file content in most editors. |
file | IFileOptions | no | Exposes the external-editor package options to configure the temporary file. |
waitForUseInput | boolean | no (default to true ) | Open the editor automatically without waiting for the user to press enter. Note that this mean the user will not see the question! So make sure you have a default value that provide guidance if it's unclear what input is expected. |
theme | See Theming | no | Customize look of the prompt. |
You can theme a prompt by passing a theme
object option. The theme object only need to includes the keys you wish to modify, we'll fallback on the defaults for the rest.
type Theme = {
prefix: string | { idle: string; done: string };
spinner: {
interval: number;
frames: string[];
};
style: {
message: (text: string, status: 'idle' | 'done' | 'loading') => string;
error: (text: string) => string;
help: (text: string) => string;
key: (text: string) => string;
};
validationFailureMode: 'keep' | 'clear';
};
validationFailureMode
defines the behavior of the prompt when the value submitted is invalid. By default, we'll keep the value allowing the user to edit it. When the theme option is set to clear
, we'll remove and reset to the default value or empty string.
Copyright (c) 2023 Simon Boudrias (twitter: @vaxilart)
Licensed under the MIT license.
FAQs
Inquirer multiline editor prompt
The npm package @inquirer/editor receives a total of 601,990 weekly downloads. As such, @inquirer/editor popularity was classified as popular.
We found that @inquirer/editor demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
CISOs are racing to adopt AI for cybersecurity, but hurdles in budgets and governance may leave some falling behind in the fight against cyber threats.
Research
Security News
Socket researchers uncovered a backdoored typosquat of BoltDB in the Go ecosystem, exploiting Go Module Proxy caching to persist undetected for years.
Security News
Company News
Socket is joining TC54 to help develop standards for software supply chain security, contributing to the evolution of SBOMs, CycloneDX, and Package URL specifications.